/****************************************************************************
 *
 * Copyright 2020 Samsung Electronics All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 *
 ****************************************************************************/

/******************************************************************************
 * @file     tz_context.h
 * @brief    Context Management for Armv8-M TrustZone
 * @version  V1.0.1
 * @date     10. January 2018
 ******************************************************************************/
/*
 * Copyright (c) 2017-2018 Arm Limited. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the License); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

 /**
 * @defgroup TRUSTZONE RTOS CONTEXT MANAGEMENT
 * @brief Provides APIs for RTOS Context Management for TrustZone
 * @ingroup KERNEL
 */

#if defined(__ICCARM__)
  #pragma system_include         /* treat file as system include file for MISRA check */
#elif defined(__clang__)
  #pragma clang system_header   /* treat file as system include file */
#endif

#ifndef TZ_CONTEXT_H
#define TZ_CONTEXT_H

#include <stdint.h>
#include <arch/irq.h>

/****************************************************************************
 * Public Type Declarations
 ****************************************************************************/

#ifndef TZ_MODULEID_T
#define TZ_MODULEID_T
/* Details Data type that identifies secure software modules called by a process */
typedef uint32_t TZ_ModuleId_t;
#endif

/* Details TZ Memory ID identifies an allocated memory slot. */
typedef uint32_t TZ_MemoryId_t;

/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
/**
 * Initialize secure context memory system
 * return execution status (1: success, 0: error)
 */
uint32_t TZ_InitContextSystem_S(void);

/**
 * Allocate context memory for calling secure software modules in TrustZone
 * param[in]  module   identifies software modules called from non-secure mode
 * return value != 0 id TrustZone memory slot identifier
 * return value 0    no memory available or internal error
 */
TZ_MemoryId_t TZ_AllocModuleContext_S(TZ_ModuleId_t module);

/**
 * Free context memory that was previously allocated with \ref TZ_AllocModuleContext_S
 * param[in]  id  TrustZone memory slot identifier
 * return execution status (1: success, 0: error)
 */
uint32_t TZ_FreeModuleContext_S(TZ_MemoryId_t id);

/**
 * Load secure context (called on RTOS thread context switch)
 * param[in]  id  TrustZone memory slot identifier
 * return execution status (1: success, 0: error)
 */
uint32_t TZ_LoadContext_S(TZ_MemoryId_t id);

/**
 * Store secure context (called on RTOS thread context switch)
 * param[in]  id  TrustZone memory slot identifier
 * return execution status (1: success, 0: error)
 */
uint32_t TZ_StoreContext_S(TZ_MemoryId_t id);

#endif						/* TZ_CONTEXT_H */
